<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  <title>cmd.DDoc</title>
  <link href="./css/style.css" rel="stylesheet" type="text/css"/>
  <!-- <link href="./img/icon.png" rel="icon" type="image/png"/> -->
  <script type="text/javascript" src="./js/jquery.js"></script>
  <script type="text/javascript" src="./js/modules.js"></script>
  <script type="text/javascript" src="./js/quicksearch.js"></script>
  <script type="text/javascript" src="./js/navigation.js"></script>
  <!--<script type="text/javascript" src="./js/jquery.treeview.js"></script>-->
  <script type="text/javascript">
    var g_moduleFQN = "cmd.DDoc";
  </script>
  
</head>
<body>
<div id="content">
  <h1><a href="./htmlsrc/cmd.DDoc.html" class="symbol">cmd.DDoc</a></h1>
  
<p class="sec_header">Author:</p>Aziz Köksal
<p class="sec_header">License:</p>GPL3
 <p><b>Maturity:</b> high.</p>
<dl>
<dt class="decl">struct <a class="symbol _struct" name="DDocCommand" href="./htmlsrc/cmd.DDoc.html#L38" kind="struct" beg="38" end="255">DDocCommand</a>; <a title="Permalink to this symbol" href="#DDocCommand" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L38">#</a></dt>
<dd class="ddef">
<div class="summary">The ddoc command.</div>
<dl>
<dt class="decl">string <a class="symbol _variable" name="DDocCommand.destDirPath" href="./htmlsrc/cmd.DDoc.html#L40" kind="variable" beg="40" end="40">destDirPath</a>; <a title="Permalink to this symbol" href="#DDocCommand.destDirPath" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L40">#</a></dt>
<dd class="ddef">
<div class="summary">Destination directory.</div></dd>
<dt class="decl">string[] <a class="symbol _variable" name="DDocCommand.macroPaths" href="./htmlsrc/cmd.DDoc.html#L41" kind="variable" beg="41" end="41">macroPaths</a>; <a title="Permalink to this symbol" href="#DDocCommand.macroPaths" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L41">#</a></dt>
<dd class="ddef">
<div class="summary">Macro file paths.</div></dd>
<dt class="decl">string[] <a class="symbol _variable" name="DDocCommand.filePaths" href="./htmlsrc/cmd.DDoc.html#L42" kind="variable" beg="42" end="42">filePaths</a>; <a title="Permalink to this symbol" href="#DDocCommand.filePaths" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L42">#</a></dt>
<dd class="ddef">
<div class="summary">Module file paths.</div></dd>
<dt class="decl">string <a class="symbol _variable" name="DDocCommand.modsTxtPath" href="./htmlsrc/cmd.DDoc.html#L43" kind="variable" beg="43" end="43">modsTxtPath</a>; <a title="Permalink to this symbol" href="#DDocCommand.modsTxtPath" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L43">#</a></dt>
<dd class="ddef">
<div class="summary">Write list of modules to this file if specified.</div></dd>
<dt class="decl">string <a class="symbol _variable" name="DDocCommand.outFileExtension" href="./htmlsrc/cmd.DDoc.html#L44" kind="variable" beg="44" end="44">outFileExtension</a>; <a title="Permalink to this symbol" href="#DDocCommand.outFileExtension" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L44">#</a></dt>
<dd class="ddef">
<div class="summary">The extension of the output files.</div></dd>
<dt class="decl">bool <a class="symbol _variable" name="DDocCommand.includeUndocumented" href="./htmlsrc/cmd.DDoc.html#L45" kind="variable" beg="45" end="45">includeUndocumented</a>; <a title="Permalink to this symbol" href="#DDocCommand.includeUndocumented" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L45">#</a></dt>
<dd class="ddef">
<div class="summary">Whether to include undocumented symbols.</div></dd>
<dt class="decl">bool <a class="symbol _variable" name="DDocCommand.useKandil" href="./htmlsrc/cmd.DDoc.html#L46" kind="variable" beg="46" end="46">useKandil</a>; <a title="Permalink to this symbol" href="#DDocCommand.useKandil" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L46">#</a></dt>
<dd class="ddef">
<div class="summary">Whether to use kandil.</div></dd>
<dt class="decl">bool <a class="symbol _variable" name="DDocCommand.writeXML" href="./htmlsrc/cmd.DDoc.html#L47" kind="variable" beg="47" end="47">writeXML</a>; <a title="Permalink to this symbol" href="#DDocCommand.writeXML" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L47">#</a></dt>
<dd class="ddef">
<div class="summary">Whether to write XML instead of HTML docs.</div></dd>
<dt class="decl">bool <a class="symbol _variable" name="DDocCommand.writeHLFiles" href="./htmlsrc/cmd.DDoc.html#L48" kind="variable" beg="48" end="48">writeHLFiles</a>; <a title="Permalink to this symbol" href="#DDocCommand.writeHLFiles" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L48">#</a></dt>
<dd class="ddef">
<div class="summary">Whether to write syntax highlighted files.</div></dd>
<dt class="decl">bool <a class="symbol _variable" name="DDocCommand.rawOutput" href="./htmlsrc/cmd.DDoc.html#L49" kind="variable" beg="49" end="49">rawOutput</a>; <a title="Permalink to this symbol" href="#DDocCommand.rawOutput" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L49">#</a></dt>
<dd class="ddef">
<div class="summary">Whether to expand macros or not.</div></dd>
<dt class="decl">bool <a class="symbol _variable" name="DDocCommand.verbose" href="./htmlsrc/cmd.DDoc.html#L50" kind="variable" beg="50" end="50">verbose</a>; <a title="Permalink to this symbol" href="#DDocCommand.verbose" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L50">#</a></dt>
<dd class="ddef">
<div class="summary">Whether to be verbose.</div></dd>
<dt class="decl">CompilationContext <a class="symbol _variable" name="DDocCommand.context" href="./htmlsrc/cmd.DDoc.html#L52" kind="variable" beg="52" end="52">context</a>; <a title="Permalink to this symbol" href="#DDocCommand.context" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L52">#</a></dt>
<dd class="ddef">
<div class="summary">Environment variables of the compilation.</div></dd>
<dt class="decl">Diagnostics <a class="symbol _variable" name="DDocCommand.diag" href="./htmlsrc/cmd.DDoc.html#L53" kind="variable" beg="53" end="53">diag</a>; <a title="Permalink to this symbol" href="#DDocCommand.diag" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L53">#</a></dt>
<dd class="ddef">
<div class="summary">Collects error messages.</div></dd>
<dt class="decl">TokenHighlighter <a class="symbol _variable" name="DDocCommand.tokenHL" href="./htmlsrc/cmd.DDoc.html#L54" kind="variable" beg="54" end="54">tokenHL</a>; <a title="Permalink to this symbol" href="#DDocCommand.tokenHL" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L54">#</a></dt>
<dd class="ddef">
<div class="summary">For highlighting tokens DDoc code sections.</div></dd>
<dt class="decl">void <a class="symbol _function" name="DDocCommand.run" href="./htmlsrc/cmd.DDoc.html#L57" kind="function" beg="57" end="117">run</a><span class="params">()</span>; <a title="Permalink to this symbol" href="#DDocCommand.run" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L57">#</a></dt>
<dd class="ddef">
<div class="summary">Executes the doc generation command.</div></dd>
<dt class="decl">void <a class="symbol _function" name="DDocCommand.writeSyntaxHighlightedFile" href="./htmlsrc/cmd.DDoc.html#L120" kind="function" beg="120" end="132">writeSyntaxHighlightedFile</a><span class="params">(Module <em>mod</em>, TagMap <em>tags</em>)</span>; <a title="Permalink to this symbol" href="#DDocCommand.writeSyntaxHighlightedFile" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L120">#</a></dt>
<dd class="ddef">
<div class="summary">Writes a syntax highlighted file for mod.</div></dd>
<dt class="decl">void <a class="symbol _function" name="DDocCommand.writeDocumentationFile" href="./htmlsrc/cmd.DDoc.html#L138" kind="function" beg="138" end="176">writeDocumentationFile</a><span class="params">(Module <em>mod</em>, MacroTable <em>mtable</em>)</span>; <a title="Permalink to this symbol" href="#DDocCommand.writeDocumentationFile" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L138">#</a></dt>
<dd class="ddef">
<div class="summary">Writes the documentation for a module to the disk.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>mod</em></td><td>the module to be processed.</td></tr>
<tr><td><em>mtable</em></td><td>the main macro environment.</td></tr></table></dd>
<dt class="decl">void <a class="symbol _function" name="DDocCommand.writeModuleLists" href="./htmlsrc/cmd.DDoc.html#L182" kind="function" beg="182" end="229">writeModuleLists</a><span class="params">(ModuleManager <em>mm</em>)</span>; <a title="Permalink to this symbol" href="#DDocCommand.writeModuleLists" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L182">#</a></dt>
<dd class="ddef">
<div class="summary">Writes the list of processed modules to the disk.
 Also writes DEST/js/modules.js if kandil is used.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>mm</em></td><td>has the list of modules.</td></tr></table></dd>
<dt class="decl">void <a class="symbol _function" name="DDocCommand.writePackage" href="./htmlsrc/cmd.DDoc.html#L232" kind="function" beg="232" end="242">writePackage</a><span class="params">(File <em>f</em>, Package <em>pckg</em>, string <em>indent</em> = "  ")</span>; <span class="attrs">[<span class="stc">static</span>]</span> <a title="Permalink to this symbol" href="#DDocCommand.writePackage" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L232">#</a></dt>
<dd class="ddef">
<div class="summary">Writes the sub-packages and sub-modules of a package to the disk.</div></dd>
<dt class="decl">string <a class="symbol _function" name="DDocCommand.loadMacroFile" href="./htmlsrc/cmd.DDoc.html#L248" kind="function" beg="248" end="254">loadMacroFile</a><span class="params">(string <em>filePath</em>, Diagnostics <em>diag</em>)</span>; <span class="attrs">[<span class="stc">static</span>]</span> <a title="Permalink to this symbol" href="#DDocCommand.loadMacroFile" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/cmd.DDoc.html#L248">#</a></dt>
<dd class="ddef">
<div class="summary">Loads a macro file. Converts any Unicode encoding to UTF-8.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>filePath</em></td><td>path to the macro file.</td></tr>
<tr><td><em>diag</em></td><td>for error messages.</td></tr></table></dd></dl></dd></dl>
</div>
<div id="footer">
  <p>Copyright © 2007-2008, Aziz Köksal. All rights reserved.</p>
  <p>Page generated by <a href="http://code.google.com/p/dil">dil</a> on Fri Dec 26 04:12:53 2008. Rendered by <a href="http://code.google.com/p/dil/wiki/Kandil">kandil</a>.</p>
</div>
</body>
</html>